package org.fatewa.engine.genius.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author 4everlynn
 * @version v2.0
 * @date 2021/8/6
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Export {

    /**
     * 指定导出时的路径
     *
     * @return 导出的路径
     */
    String path();

    /**
     * 是否支持分页接口
     *
     * @return 是否支持分页接口
     */
    boolean page() default true;

    /**
     * 是否支持创建接口
     *
     * @return 是否支持创建接口
     */
    boolean create() default false;

    /**
     * 是否支持删除接口
     *
     * @return 是否支持删除接口
     */
    boolean delete() default false;

    /**
     * 是否支持更新接口
     *
     * @return 是否支持更新接口
     */
    boolean update() default false;

    /**
     * 是否支持根据 ID 获取单个实体
     *
     * @return 是否支持根据 ID 获取单个实体
     */
    boolean single() default false;

    /**
     * 设置需要导出的关联接口
     *
     * @return Relations
     */
    Relation[] relation() default {};
}
